Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.logicboxes.foundation.sfnb.order.digicert
Class DigitalCertificateOrder

java.lang.Object
  extended by com.logicboxes.foundation.sfnb.order.digicert.DigitalCertificateOrder

public class DigitalCertificateOrder
extends java.lang.Object

Constructor Summary
DigitalCertificateOrder()
           
 
Method Summary
 java.util.HashMap add(java.lang.String userName, java.lang.String password, java.lang.String role, java.lang.String langpref, int parentid, java.lang.String productKey, java.lang.String domainName, int customerID, int noOfYears, java.util.HashMap orderParams, java.lang.String invoiceOption)
          Deprecated. 
 java.util.HashMap addAdditionalLicenses(java.lang.String userName, java.lang.String password, java.lang.String role, java.lang.String langpref, int parentid, int orderId, int noOfAdditionalLicenses, java.lang.String invoiceOption)
          Deprecated. 
 java.util.HashMap addCertificate(java.lang.String userName, java.lang.String password, java.lang.String role, java.lang.String langpref, int parentid, java.lang.String productKey, java.lang.String domainName, int customerID, int noOfYears, int additionalLicenses, java.util.HashMap orderParams, java.lang.String invoiceOption)
          Places a Digital Certificate Order for the specified domain name.
 java.util.HashMap cancelDigicertOrder(java.lang.String userName, java.lang.String password, java.lang.String role, java.lang.String langpref, int parentid, int orderId)
          This method is used to cancel the specified order.
Cancel Order is allowed only for those order's whose current status is 'Active' and BEFORE SUCCESSFUL ENROLLMENT.
Cancellation of a Digital Certificate order results cancellation of Invoice for the order.
 java.util.HashMap changeDigicertPassword(java.lang.String userName, java.lang.String password, java.lang.String role, java.lang.String langpref, int parentid, int orderId, java.lang.String newPassword)
          Deprecated. 
 java.util.HashMap checkDigitalCertificateStatus(java.lang.String userName, java.lang.String password, java.lang.String role, java.lang.String langpref, int parentid, int orderId, boolean standardCertFormat)
          Check certificate status for the Certificate Order Number which is associated with the specified orderid.
 java.util.HashMap del(java.lang.String userName, java.lang.String password, java.lang.String role, java.lang.String langpref, int parentid, int orderID)
          Deletes the specified order.
Delete Order is allowed only for those order's whose current status is 'Active' and AFTER SUCCESSFUL ENROLLMENT.
 java.util.HashMap enrollForThawteCertificate(java.lang.String userName, java.lang.String password, java.lang.String role, java.lang.String langpref, int parentid, int orderId, java.util.HashMap enrollHash)
          Enrolls for the certificate for specified orderid.
 java.util.HashMap getCertPrice(java.lang.String userName, java.lang.String password, java.lang.String role, java.lang.String langpref, int parentid, java.lang.String productkey)
          This method gives the prices for customer for each certificate type of the given productkey.
 java.util.HashMap getDetails(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int orderId, java.util.Vector option)
          Returns entity details depending upon various option values.
 java.util.HashMap getDetailsByDomain(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, java.lang.String domainName, java.util.Vector option, java.lang.String productkey)
          Returns digital certificate order details for the domain name which depending upon various option values.
 int getOrderIdByDomain(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, java.lang.String domainName, java.lang.String productkey)
          Returns digital certificate orderid which is associated with the domain name
 java.util.HashMap reissue(java.lang.String userName, java.lang.String password, java.lang.String role, java.lang.String langpref, int parentid, int orderId, java.lang.String csrString, java.lang.String csrSoftware, java.lang.String approverEmail)
          Reissues an existing Digital Certificate.
 java.util.HashMap renew(java.lang.String userName, java.lang.String password, java.lang.String role, java.lang.String langpref, int parentid, int entityId, int renewYears, java.lang.String existingEndTime, java.lang.String csrString, java.lang.String invoiceOption, int additionalLicenses, java.lang.String orgName, java.lang.String orgStreet, java.lang.String orgCity, java.lang.String orgRegion, java.lang.String orgZip, java.lang.String orgCountry, java.lang.String orgPhone)
          Deprecated. 
 java.util.HashMap renewCertificate(java.lang.String userName, java.lang.String password, java.lang.String role, java.lang.String langpref, int parentid, int orderId, int renewYears, int additionalLicenses, java.lang.String existingEndTime, java.lang.String invoiceOption, java.util.HashMap renewHash)
          Renews an existing Digital Certificate.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DigitalCertificateOrder

public DigitalCertificateOrder()
Method Detail

add

@Deprecated
public java.util.HashMap add(java.lang.String userName,
                                        java.lang.String password,
                                        java.lang.String role,
                                        java.lang.String langpref,
                                        int parentid,
                                        java.lang.String productKey,
                                        java.lang.String domainName,
                                        int customerID,
                                        int noOfYears,
                                        java.util.HashMap orderParams,
                                        java.lang.String invoiceOption)
Deprecated. 

Places a Digital Certificate Order for the specified domain name. Since this is a billable action, your reseller account must have sufficient funds to add the Digital Certificate order.

Parameters:
productKey - The productkey identifies the Certificating Issuing Authority of Digital Certificate. The current acceptable values for this parameter is
thawtecert - Thawte Digital Certificate
domainName - The domain name for which the order is placed.
customerID - The customer for whom the orders should be added.
noOfYears - The number of years for which the order is placed. The order can be added for 1 or 2 Years.
orderParams - For adding a Digital Certificate, the orderParams Hashtable should contain a "certkey" as a parameter.
"certkey" specifies the type of Digital Certificate. This "certkey" is dependent on the Product key. Currently the certkeys for thawtecert are sgc = SGC SuperCerts ssl = SSL Web Server Certificates fssl = SSL123 Certificates wild = Wildcard Certificates
invoiceOption - This parameter will decide how the Customer Invoices will be handled.

NoInvoice - If this value is passed, then no customer invoice will be generated for the domains.

PayInvoice - If this value is passed, then a customer invoice will be generated for the domains in the first step. If there is sufficient balance in the Customer's Debit Account, then the invoices will be paid and the domains will be registered. If a customer has less balance than required, then as many domains as possible will be registered with the existing funds. All other orders will remain pending in the system.

KeepInvoice - If this value is passed, then a customer invoice will be generated for the domains. However, these invoices will not be paid. They will be kept pending, while the orders will be executed.

OnlyAdd - The order will simply be added but NOT executed in the system. A customer invoice will be generated. However, the invoice will not be paid.

Returns:
A Hashtable with the result of Order addition. The Hashtable will have key-values as follows:

status=Success

Incase you have chosen "NoInvoice", the return HashMap will also contains following data: eaqid = 255563

Incase you have chosen "PayInvoice", the return HashMap will also contain the following data: actiontypedesc = Addition of Digital Certificate order for maheshdoc4.com for 1 year(s) unutilisedsellingamount = -7.490 pendingamount = 7.49 sellingamount = -7.490 entityid = 553259 (OrderId) customerid = 29410 invoiceid = 9815 sellingcurrencysymbol = ADF actionstatusdesc = Invoice is partly paid

invoiceid is the Id that you will need to pass to Fund.payCustomerTransaction if you wish to pay the invoice at a later date.

selllingamount is the Invoice amount in your Selling Currency

unutilisedselllingamount is the Pending Invoice amount in your Selling Currency.

In case of "PayInvoice", if the Customer does not have sufficient funds to pay the entire invoice amount, unutilisedsellingamount will reflect the balance amount that is pending.

Incase you have chosen "KeepInvoice" , the return HashMap will also contain the following data: sellingcurrencysymbol sellingamount customerid eaqid invoiceid unutilisedsellingamount

In case of "KeepInvoice", the pending amount will always be equal to the invoice amount.

Incase you have chosen "OnlyAdd" , the return HashMap will also contain the following data: actiontypedesc = Addition of Digital Certificate order for maheshdoc6.com for 1 year(s) actionstatus = PendingExecution actionadded = 1155568302 entityid = 553266 (OrderId) eaqid = 173540 description = maheshdoc6.com priority = 7 actiontype = AddOrder entitytypeid = 50 actionstatusdesc = Wating For Enroll Certificate orderid = 553266 customercost = 7.49 invoiceid = 9833

getCertPrice

public java.util.HashMap getCertPrice(java.lang.String userName,
                                      java.lang.String password,
                                      java.lang.String role,
                                      java.lang.String langpref,
                                      int parentid,
                                      java.lang.String productkey)
This method gives the prices for customer for each certificate type of the given productkey.

Parameters:
productkey - The product key identifies the Certificating Issuing Authority of Digital Certificate. The current acceptable values for this parameter is
"thawtecert" - Thawte Digital Certificate
Returns:
A Hashtable with the result of price for each certkey.

enrollForThawteCertificate

public java.util.HashMap enrollForThawteCertificate(java.lang.String userName,
                                                    java.lang.String password,
                                                    java.lang.String role,
                                                    java.lang.String langpref,
                                                    int parentid,
                                                    int orderId,
                                                    java.util.HashMap enrollHash)
Enrolls for the certificate for specified orderid.

Parameters:
orderId - The orderid for which you want to enroll for a certificate
enrollHash - This Hashtable contains the enrollment details. Keys of this hashtable are case sensitive. The hashtable contains key-values as:
  • org_name - The organisation Name
  • org_street1 - Organization address
  • org_city - Organization city
  • org_state - Organization state
  • org_postalcode - Organization Postal code
  • org_country - Organization two letter ISO-3166 country identifier i.e. country code. (eg US for United States, IN for India)
  • org_phone - Organization contact Phone number including international country code. (eg 001 415 12345678)
  • org_fax - Organization contact Fax number including international country code. (eg 001 415 12345678)

  • admin_firstname - First name of the Admin contact person
  • admin_lastname - Last name of the Admin contact person
  • admin_jobtitle - Admin contact job title
  • admin_telephone - Admin contact telephone number including international country code. (eg 001 415 12345678)
  • admin_email - Admin Contact email address

  • tech_firstname - First name of the technical contact person
  • tech_lastname - Last name of the technical contact person
  • tech_jobtitle - Technical contact job title
  • tech_telephone - Technical contact telephone number including international country code. (eg 001 415 12345678)
  • tech_email - Technical Contact email address

  • approveremail - The approverEmail value (e.g. ssladmin@domainname.com).
    Valid approverEmail values are:
    • One of the registered domain contacts (admin or tech) found in the whois database for the associated domain.
    • Or one of the pre-setup emails listed belowsetup @domainname.com.For sub domains an email @domainname.com is also valid
    • admin@domainname.com
    • administrator@domainname.com
    • hostmaster@domainname.com
    • info@domainname.com
    • SSLadmin@domainname.com
    • SSLadministrator@domainname.com
    • SSLwebmaster@domainname.com
    • sysadmin@domainname.com
    • webmaster@domainname.com
    • root@domainname.com
    • is@domainname.com
    • it@domainname.com
    • mis@domainname.com
    • postmaster@domainname.com
    • support@geotrust.com (As a last resort this email should be used. This may take several business days when used.)

  • software - Web Server software identifier for which the certificate is purchased.
    Valid Web Server software identifiers are:
    • IIS
    • Other
  • csrString - Base64 encoded CSR string complete with the begin and end markers. eg
    -----BEGIN NEW CERTIFICATE REQUEST-----
    MIIBwzCCASwCAQAwgYIxCzAJBgNVBAYTAklOMRQwEgYDVQQIEwtNYWhhcmFzaHRyYTEPMA0GA1UE BxMGTXVtYmFpMRcwFQYDVQQKEw5NYWhlc2ggUHZ0IEx0ZDEYMBYGA1UECxMPUHJpdmF0ZSBDb21w YW55MRkwFwYDVQQDExB2ZXJpZW5yb2xsMDEuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKB gQCMSw8CmFebNAiyvwG7HJ/bGBqgqZvkNpzQtmtd79id+LcAXbCx5+TDdoTeGhQ33dUC2c2g5dxx N2hqRlR1H+vFR/FeYXC41abfPm5jS3OTQ4J1H/HM6lm4MVVEIQLwjzUxPtsUML5QtBjkolob2VB7 8A9QdDvSEkS+COaMXRSUqQIDAQABoAAwDQYJKoZIhvcNAQEEBQADgYEACCpjqsN2ZRjGtPTWp1G+ jHTrgAamxSDrHAddw9mi1IDk1N3ZXgp5gHBZ4L5av+4E6GUhTE5FCLylNxojxMjHnssALFjabqed ufJIj0ay8YSS6fBhXQeVE4oGP96djeheLLigCEAufzWjprr6oA6YRXmwAAdokmpkjyxwrtlNV0I=
    -----END NEW CERTIFICATE REQUEST-----
Returns:
A HashMap with the result of enroll. The Hashtable will have key-values as follows:
  • status - Status of the enrollment request. success or failure
  • certcode - Certificate Order number eg. IMAHESH01
      • Throws:
      ValidationException
      LogicBoxesException

reissue

public java.util.HashMap reissue(java.lang.String userName,
                                 java.lang.String password,
                                 java.lang.String role,
                                 java.lang.String langpref,
                                 int parentid,
                                 int orderId,
                                 java.lang.String csrString,
                                 java.lang.String csrSoftware,
                                 java.lang.String approverEmail)
Reissues an existing Digital Certificate.
The certificate can Reissue only if the certificate status is Issued.

Parameters:
orderId - The orderid for which you want to Reissue the certificate
csrString - Base64 encoded CSR string complete with the begin and end markers. eg
Example : -----BEGIN NEW CERTIFICATE REQUEST----- MIIBwzCCASwCAQAwgYIxCzAJBgNVBAYTAklOMRQwEgYDVQQIEwtNYWhhcmFzaHRyYTEPMA0GA1UE BxMGTXVtYmFpMRcwFQYDVQQKEw5NYWhlc2ggUHZ0IEx0ZDEYMBYGA1UECxMPUHJpdmF0ZSBDb21w YW55MRkwFwYDVQQDExB2ZXJpZW5yb2xsMDEuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKB gQCMSw8CmFebNAiyvwG7HJ/bGBqgqZvkNpzQtmtd79id+LcAXbCx5+TDdoTeGhQ33dUC2c2g5dxx N2hqRlR1H+vFR/FeYXC41abfPm5jS3OTQ4J1H/HM6lm4MVVEIQLwjzUxPtsUML5QtBjkolob2VB7 8A9QdDvSEkS+COaMXRSUqQIDAQABoAAwDQYJKoZIhvcNAQEEBQADgYEACCpjqsN2ZRjGtPTWp1G+ jHTrgAamxSDrHAddw9mi1IDk1N3ZXgp5gHBZ4L5av+4E6GUhTE5FCLylNxojxMjHnssALFjabqed ufJIj0ay8YSS6fBhXQeVE4oGP96djeheLLigCEAufzWjprr6oA6YRXmwAAdokmpkjyxwrtlNV0I=
-----END NEW CERTIFICATE REQUEST-----
csrSoftware - Web Server software identifier for which the certificate is to be Reissue
Valid Web Server software identifiers are:
  • IIS
  • Other
    • approverEmail - The approverEmail of the certificate must match the registrant/admin contact of the domain.
    Returns:
    A Hashtable with the result of Reissue. The Hashtable will have key-values as follows:
    • status = success / failure
    • eaqid = 173540
    • orderid = 553259
    • domainname = yourdomainname.com
    • actiontype = ReissueOrder
    • actiontypedesc = Reissue Digital Certificate for domain yourdomainname.com
    • actionstatus = WaitingForCheckDigicertStatus
    • actionstatusdesc = Action Waiting For Certificate Issue.
    • csrSoftware = Web server software identifier for which the certificate is reissued
    Throws:
    LogicBoxesException

renew

@Deprecated
public java.util.HashMap renew(java.lang.String userName,
                                          java.lang.String password,
                                          java.lang.String role,
                                          java.lang.String langpref,
                                          int parentid,
                                          int entityId,
                                          int renewYears,
                                          java.lang.String existingEndTime,
                                          java.lang.String csrString,
                                          java.lang.String invoiceOption,
                                          int additionalLicenses,
                                          java.lang.String orgName,
                                          java.lang.String orgStreet,
                                          java.lang.String orgCity,
                                          java.lang.String orgRegion,
                                          java.lang.String orgZip,
                                          java.lang.String orgCountry,
                                          java.lang.String orgPhone)
Deprecated. 

Renews an existing Digital Certificate. The certificate can be Renewed only if the certificate is 'renewable' The 'isrenewable' value will come from Check Certificate Status call.

Since this is a billable action your reseller account must have sufficient funds to renew the Digital Certificate order.

Parameters:
entityId - The orderid for which you want to Renew the certificate
renewYears - The number of years for which the certificate is to be renewed.
The certificate can be renewed for 1 or 2 Years.
existingEndTime - The current end time for this orders in milliseconds
csrString - Base64 encoded CSR string complete with the begin and end markers.
You have to provide the new CSR only if your Digital Certificate is not re-signable. The 'isresignable' value will come from Check Certificate Status call.
CSR eg.:
----BEGIN NEW CERTIFICATE REQUEST---- MIIBwzCCASwCAQAwgYIxCzAJBgNVBAYTAklOMRQwEgYDVQQIEwtNYWhhcmFzaHRyYTEPMA0GA1UE BxMGTXVtYmFpMRcwFQYDVQQKEw5NYWhlc2ggUHZ0IEx0ZDEYMBYGA1UECxMPUHJpdmF0ZSBDb21w YW55MRkwFwYDVQQDExB2ZXJpZW5yb2xsMDEuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKB gQCMSw8CmFebNAiyvwG7HJ/bGBqgqZvkNpzQtmtd79id+LcAXbCx5+TDdoTeGhQ33dUC2c2g5dxx N2hqRlR1H+vFR/FeYXC41abfPm5jS3OTQ4J1H/HM6lm4MVVEIQLwjzUxPtsUML5QtBjkolob2VB7 8A9QdDvSEkS+COaMXRSUqQIDAQABoAAwDQYJKoZIhvcNAQEEBQADgYEACCpjqsN2ZRjGtPTWp1G+ jHTrgAamxSDrHAddw9mi1IDk1N3ZXgp5gHBZ4L5av+4E6GUhTE5FCLylNxojxMjHnssALFjabqed ufJIj0ay8YSS6fBhXQeVE4oGP96djeheLLigCEAufzWjprr6oA6YRXmwAAdokmpkjyxwrtlNV0I=
----END NEW CERTIFICATE REQUEST----
invoiceOption - This parameter will decide how the Customer Invoices will be handled.
  • NoInvoice - If this value is passed, then no customer invoice will be generated for the domains.
  • PayInvoice - If this value is passed, then a customer invoice will be generated for the domains in the first step. If there is sufficient balance in the Customer's Debit Account, then the invoices will be paid and the domains will be registered. If a customer has less balance than required, then as many domains as possible will be registered with the existing funds. All other orders will remain pending in the system.
  • KeepInvoice - If this value is passed, then a customer invoice will be generated for the domains. However, these invoices will not be paid. They will be kept pending, while the orders will be executed.
  • OnlyAdd - The order will simply be added but NOT executed in the system. A customer invoice will be generated. However, the invoice will not be paid.
Returns:
Hashtable with following keys
  • invoiceid - ID for invoice generated
  • customercost - Cost for customer
  • customerid - customer's ID to which renewed order belongs
  • domainname - domain for which order is renewed
Certain other information related to the action is also returned as a part of the Hashtable
Throws:
LogicBoxesException

checkDigitalCertificateStatus

public java.util.HashMap checkDigitalCertificateStatus(java.lang.String userName,
                                                       java.lang.String password,
                                                       java.lang.String role,
                                                       java.lang.String langpref,
                                                       int parentid,
                                                       int orderId,
                                                       boolean standardCertFormat)
Check certificate status for the Certificate Order Number which is associated with the specified orderid.

Parameters:
orderId - The orderid for which you want to check the certificate status
standardCertFormat - Type of the certificate format.
  • true - for standard (X509) certificate format
  • false - for pkcs7text (PKCS#7) certificate format
      • Returns:
      A Hashtable having certificate status details.
      This contains the Certificate Verification Details, Product Details, Certificate Details, Organization Details, Corporate Details, Technical Contact Details, Address Details
      If certificate's overall status is Issued, it gives serial number, certificate, etc
      The Hashtable will have key-values as follows:

      For successful response:

      • certVerificationStatus - Overall certificate status eg. Issued, Pending, etc
      • domainOwnershipVerified - Is the domain ownrship verified. Valids are true and false
      • companyRegistrationVerified - Is the company registration verified. Valids are true and false
      • telephoneVerificationDone - Is the telephone number verified. Valids are true and false

      • domainName - Domain name
      • validFrom - Day on which the validity of the certificate starts. Format: YYYY/MM/DD
      • validTo - Day on which the validity of the certificate expires. Format: YYYY/MM/DD
      • lifeSpan - Certificate life span in number of year(s).
      • addtionalLicenses - Number of Additional Licenses associated with this certificate.
      • auth_contact - The preferred authorizing contact to be used. Valid auth_contact are:
        • auth - use the corporate contact details
        • tech - use the technical contact details

      • certNameCode - Type of purchased Digital Certificate. eg. fssl, ssl, etc
      • certOrderNumber - Certificate Order Number. eg. IMAHESH01
      • certificateStatus - Overall certificate status eg. Issued, Pending, etc
      • resignable - Can this certificate be resigned, depending on its software type. Valids are true and false
      • renewable - Can this certificate be Renew. Valids are true and false
      • reissuable - Can this certificate be Reissue. Valids are true and false
      • csrSoftware - Web Server software identifier for which the certificate is purchased.
      • csrPassword - User selected certificate maintenance password
      • certHexSerial - Certificate serial number as a hexadecimal number. Available only once certificate is Issued and ready for delivery.
      • certificateString - Base64 encoded CSR string complete with the begin and end markers. Available only once certificate is Issued and ready for delivery. eg
        ----BEGIN NEW CERTIFICATE REQUEST----
        MIIBwzCCASwCAQAwgYIxCzAJBgNVBAYTAklOMRQwEgYDVQQIEwtNYWhhcmFzaHRyYTEPMA0GA1UE BxMGTXVtYmFpMRcwFQYDVQQKEw5NYWhlc2ggUHZ0IEx0ZDEYMBYGA1UECxMPUHJpdmF0ZSBDb21w YW55MRkwFwYDVQQDExB2ZXJpZW5yb2xsMDEuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKB gQCMSw8CmFebNAiyvwG7HJ/bGBqgqZvkNpzQtmtd79id+LcAXbCx5+TDdoTeGhQ33dUC2c2g5dxx N2hqRlR1H+vFR/FeYXC41abfPm5jS3OTQ4J1H/HM6lm4MVVEIQLwjzUxPtsUML5QtBjkolob2VB7 8A9QdDvSEkS+COaMXRSUqQIDAQABoAAwDQYJKoZIhvcNAQEEBQADgYEACCpjqsN2ZRjGtPTWp1G+ jHTrgAamxSDrHAddw9mi1IDk1N3ZXgp5gHBZ4L5av+4E6GUhTE5FCLylNxojxMjHnssALFjabqed ufJIj0ay8YSS6fBhXQeVE4oGP96djeheLLigCEAufzWjprr6oA6YRXmwAAdokmpkjyxwrtlNV0I=
        ----END NEW CERTIFICATE REQUEST----

      • organisationName - Organisation name
      • organisationType - Organisation type (eg. PrivateCompany)
      • organisationDept - Organisation department
      • organisationCity - Organisation city
      • organisationState - Organisation state
      • organisationCountry - Organisation country

      • corpFirstName - First name of the corporate contact person
      • corpLastName - Last name of the corporate contact person
      • corpJobTitle - Corporate contact job title
      • corpEmail - Corporate Contact email address
      • corpEmailAlias - Corporate Contact email alias (ONLY APPLIES TO SSL123). Only need to supply the alias value (e.g. ssladmin).
      • corpTele - Corporate contact telephone number including international country code. (eg 001 415 12345678)

      • techFirstName - First name of the technical contact person
      • techLastName - Last name of the technical contact person
      • techJobTitle - Technical contact job title
      • techEmail - Technical Contact email address
      • techTele - Technical contact telephone number including international country code. (eg 001 415 12345678)

      • street1 - Organization address's first line
      • street2 - Organization address's second line
      • city - Organization city
      • state - Organization state
      • postalCode - Organization Postal code
      • country - Organization two letter ISO-3166 country identifier i.e. country code. (eg US for United States, IN for India)
      • fax - Organization contact Fax number including international country code. (eg 001 415 12345678)

      For error response:

      • error - The description of error.

      Throws:
      LogicBoxesException

del

public java.util.HashMap del(java.lang.String userName,
                             java.lang.String password,
                             java.lang.String role,
                             java.lang.String langpref,
                             int parentid,
                             int orderID)
Deletes the specified order.
Delete Order is allowed only for those order's whose current status is 'Active' and AFTER SUCCESSFUL ENROLLMENT. After the successful Deletion of order, the digital certificate associated with this order will not work. The certificate will get Revoked at CA (Certificate Authority)

Parameters:
orderID - Order identifier which has to be deleted
Returns:
A Hashtable with the status of action. The Hashtable will have key-values as follows:
  • status - success
Certain other information related to the action is also returned as a part of the HashMap
Throws:
LogicBoxesException

cancelDigicertOrder

public java.util.HashMap cancelDigicertOrder(java.lang.String userName,
                                             java.lang.String password,
                                             java.lang.String role,
                                             java.lang.String langpref,
                                             int parentid,
                                             int orderId)
This method is used to cancel the specified order.
Cancel Order is allowed only for those order's whose current status is 'Active' and BEFORE SUCCESSFUL ENROLLMENT.
Cancellation of a Digital Certificate order results cancellation of Invoice for the order.

Parameters:
orderId - The orderid for which you want to Cancel Order
Returns:
A Hashtable with the status of action. The Hashtable will have key-values as follows:
  • status - the status of action as success or failed

Certain other information related to the action is also returned as a part of the Hashtable

Throws:
LogicBoxesException

changeDigicertPassword

@Deprecated
public java.util.HashMap changeDigicertPassword(java.lang.String userName,
                                                           java.lang.String password,
                                                           java.lang.String role,
                                                           java.lang.String langpref,
                                                           int parentid,
                                                           int orderId,
                                                           java.lang.String newPassword)
Deprecated. 

This method changes the Certificate Maintenance Password which is associated with the specified orderid. If you have modified the Certificate Maintenance Password directly through CA (Certificate Authority) e.g. Thawte, then using this method you can change the Certificate Maintenance password. If the passwords is different at CA, then your operations will fail. Change Certificate Maintenance Password is allowed when order's current status is Active and certificate's status is Issued.

Parameters:
orderId - The orderid for which you want to change the Certificate Maintenance Password.
newPassword - The new password
Returns:
A Hashtable with the status of action. The Hashtable will have key-values as follows:
  • status - success

addAdditionalLicenses

@Deprecated
public java.util.HashMap addAdditionalLicenses(java.lang.String userName,
                                                          java.lang.String password,
                                                          java.lang.String role,
                                                          java.lang.String langpref,
                                                          int parentid,
                                                          int orderId,
                                                          int noOfAdditionalLicenses,
                                                          java.lang.String invoiceOption)
Deprecated. 

Purchase Additional Licenses for the specified orderid. Additional Licenses can be purchased when the same certificate is required to be deployed on more than one physical Web server. Thus for 2 web servers 1 additional license is required

Parameters:
orderId - The orderid for which you want to puchase additional licenses.
noOfAdditionalLicenses - Number of Additional Licenses to be purchase.
invoiceOption - This parameter will decide how the Customer Invoices will be handled.
  • NoInvoice - If this value is passed, then no customer invoice will be generated for the domains.
  • PayInvoice - If this value is passed, then a customer invoice will be generated for the domains in the first step. If there is sufficient balance in the Customer's Debit Account, then the invoices will be paid and the domains will be registered. If a customer has less balance than required, then as many domains as possible will be registered with the existing funds. All other orders will remain pending in the system.
  • KeepInvoice - If this value is passed, then a customer invoice will be generated for the domains. However, these invoices will not be paid. They will be kept pending, while the orders will be executed.
  • OnlyAdd - The order will simply be added but NOT executed in the system. A customer invoice will be generated. However, the invoice will not be paid.
Returns:
Throws:
LogicBoxesException

getOrderIdByDomain

public int getOrderIdByDomain(java.lang.String SERVICE_USERNAME,
                              java.lang.String SERVICE_PASSWORD,
                              java.lang.String SERVICE_ROLE,
                              java.lang.String SERVICE_LANGPREF,
                              int SERVICE_PARENTID,
                              java.lang.String domainName,
                              java.lang.String productkey)
Returns digital certificate orderid which is associated with the domain name

Parameters:
domainName - The domain name for which the details are required
productkey - The productkey identifies the Certificating Issuing Authority of Digital Certificate. The current acceptable value for this parameter is
  • thawtecert - Thawte Digital Certificate
Returns:
Hashtable - Digital certificate orderid which is associated with the given domain name

getDetails

public java.util.HashMap getDetails(java.lang.String SERVICE_USERNAME,
                                    java.lang.String SERVICE_PASSWORD,
                                    java.lang.String SERVICE_ROLE,
                                    java.lang.String SERVICE_LANGPREF,
                                    int SERVICE_PARENTID,
                                    int orderId,
                                    java.util.Vector option)
Returns entity details depending upon various option values. Pass 'All' if all details required

Parameters:
orderId - - OrderId for which details are required
option - - Vector of different option for details listing. Allowed Option values are
  • All
  • StatusDetails
  • orderInfo
  • orderDetailedInfo
  • OrderDetails
  • ExecutionInfoParams
  • customerDetails
  • resellerdetails
  • ConflictDetails
  • PricingDetails
Returns:
Hashtable - key/value pair for all fields depending upon option selected

getDetailsByDomain

public java.util.HashMap getDetailsByDomain(java.lang.String SERVICE_USERNAME,
                                            java.lang.String SERVICE_PASSWORD,
                                            java.lang.String SERVICE_ROLE,
                                            java.lang.String SERVICE_LANGPREF,
                                            int SERVICE_PARENTID,
                                            java.lang.String domainName,
                                            java.util.Vector option,
                                            java.lang.String productkey)
Returns digital certificate order details for the domain name which depending upon various option values. Pass 'All' if all details required

Parameters:
domainName - The domain name for which the details are required
option - Vector of different option for details listing. Allowed Option values are
  • All
  • StatusDetails
  • orderInfo
  • orderDetailedInfo
  • OrderDetails
  • ExecutionInfoParams
  • customerDetails
  • resellerdetails
  • ConflictDetails
  • PricingDetails
productkey - The productkey identifies the Certificating Issuing Authority of Digital Certificate. The current acceptable values for this parameter is
  • thawtecert - Thawte Digital Certificate
Returns:
Hashtable - key/value pair for all fields depending upon option selected

addCertificate

public java.util.HashMap addCertificate(java.lang.String userName,
                                        java.lang.String password,
                                        java.lang.String role,
                                        java.lang.String langpref,
                                        int parentid,
                                        java.lang.String productKey,
                                        java.lang.String domainName,
                                        int customerID,
                                        int noOfYears,
                                        int additionalLicenses,
                                        java.util.HashMap orderParams,
                                        java.lang.String invoiceOption)
Places a Digital Certificate Order for the specified domain name. Since this is a billable action, your reseller account must have sufficient funds to add the Digital Certificate order.

Parameters:
productKey - The productkey identifies the Certificatr Issuing Authority of Digital Certificate. The current acceptable value for this parameter is
thawtecert - Thawte Digital Certificate
domainName - The Domain Name for which the order is placed.
customerID - The customer for whom the order should be added.
noOfYears - The number of years for which the order is placed. The order can be added for 1 or 2 Years.
additionalLicenses - The number of additional Licenses for the order.. The number additional Licenses should be greater than or equal to 0
orderParams - For adding a Digital Certificate, the orderParams Hashtable should contain a "certkey" as a parameter.
"certkey" specifies the type of Digital Certificate. This "certkey" is dependent on the Product key. Currently the certkeys for thawtecert are sgc = SGC SuperCerts ssl = SSL Web Server Certificates fssl = SSL123 Certificates wild = Wildcard Certificates
invoiceOption - This parameter will decide how the Customer Invoices will be handled.

NoInvoice - If this value is passed, then no customer invoice will be generated for the domains.

PayInvoice - If this value is passed, then a customer invoice will be generated for the domains in the first step. If there is sufficient balance in the Customer's Debit Account, then the invoices will be paid and the domains will be registered. If a customer has less balance than required, then as many domains as possible will be registered with the existing funds. All other orders will remain pending in the system.

KeepInvoice - If this value is passed, then a customer invoice will be generated for the domains. However, these invoices will not be paid. They will be kept pending, while the orders will be executed.

OnlyAdd - The order will simply be added but NOT executed in the system. A customer invoice will be generated. However, the invoice will not be paid.

Returns:
A Hashtable with the result of Order addition. The Hashtable will have key-values as follows:

status=Success

Incase you have chosen "NoInvoice", the return HashMap will also contains following data: eaqid = 255563

Incase you have chosen "PayInvoice", the return HashMap will also contain the following data: actiontypedesc = Addition of Digital Certificate order for maheshdoc4.com for 1 year(s) unutilisedsellingamount = -7.490 pendingamount = 7.49 sellingamount = -7.490 entityid = 553259 (OrderId) customerid = 29410 invoiceid = 9815 sellingcurrencysymbol = ADF actionstatusdesc = Invoice is partly paid

invoiceid is the Id that you will need to pass to Fund.payCustomerTransaction if you wish to pay the invoice at a later date.

selllingamount is the Invoice amount in your Selling Currency

unutilisedselllingamount is the Pending Invoice amount in your Selling Currency.

In case of "PayInvoice", if the Customer does not have sufficient funds to pay the entire invoice amount, unutilisedsellingamount will reflect the balance amount that is pending.

Incase you have chosen "KeepInvoice" , the return HashMap will also contain the following data: sellingcurrencysymbol sellingamount customerid eaqid invoiceid unutilisedsellingamount

In case of "KeepInvoice", the pending amount will always be equal to the invoice amount.

Incase you have chosen "OnlyAdd" , the return HashMap will also contain the following data: actiontypedesc = Addition of Digital Certificate order for maheshdoc6.com for 1 year(s) actionstatus = PendingExecution actionadded = 1155568302 entityid = 553266 (OrderId) eaqid = 173540 description = maheshdoc6.com priority = 7 actiontype = AddOrder entitytypeid = 50 actionstatusdesc = Waiting For Enroll Certificate orderid = 553266 customercost = 7.49 invoiceid = 9833

Throws:
LogicBoxesException

renewCertificate

public java.util.HashMap renewCertificate(java.lang.String userName,
                                          java.lang.String password,
                                          java.lang.String role,
                                          java.lang.String langpref,
                                          int parentid,
                                          int orderId,
                                          int renewYears,
                                          int additionalLicenses,
                                          java.lang.String existingEndTime,
                                          java.lang.String invoiceOption,
                                          java.util.HashMap renewHash)
Renews an existing Digital Certificate. Since this is a billable action your reseller account must have sufficient funds to renew the Digital Certificate order.

Parameters:
orderId - The orderid for which you want to Renew the certificate
renewYears - The number of years for which the certificate is to be renewed.
The certificate can be renewed for 1 or 2 Years.
additionalLicenses - The number of additionalLicenses for this order
existingEndTime - The current end time for this order in milliseconds
invoiceOption - This parameter will decide how the Customer Invoices will be handled.
  • NoInvoice - If this value is passed, then no customer invoice will be generated for the domains.
  • PayInvoice - If this value is passed, then a customer invoice will be generated for the domains in the first step. If there is sufficient balance in the Customer's Debit Account, then the invoices will be paid and the domains will be registered. If a customer has less balance than required, then as many domains as possible will be registered with the existing funds. All other orders will remain pending in the system.
  • KeepInvoice - If this value is passed, then a customer invoice will be generated for the domains. However, these invoices will not be paid. They will be kept pending, while the orders will be executed.
  • OnlyAdd - The order will simply be added but NOT executed in the system. A customer invoice will be generated. However, the invoice will not be paid.
renewHash - This Hashtable contains the renew details. Keys of this hashtable are case sensitive. The hashtable contains key-values as:
  • org_name - The organisation Name
  • org_street1 - Organization address
  • org_city - Organization city
  • org_state - Organization state
  • org_postalcode - Organization Postal code
  • org_country - Organization two letter ISO-3166 country identifier i.e. country code. (eg US for United States, IN for India)
  • org_phone - Organization contact Phone number including international country code. (eg 001 415 12345678)
  • org_fax - Organization contact Fax number including international country code. (eg 001 415 12345678)

  • admin_firstname - First name of the Admin contact person
  • admin_lastname - Last name of the Admin contact person
  • admin_jobtitle - Admin contact job title
  • admin_telephone - Admin contact telephone number including international country code. (eg 001 415 12345678)
  • admin_email - Admin Contact email address

  • tech_firstname - First name of the technical contact person
  • tech_lastname - Last name of the technical contact person
  • tech_jobtitle - Technical contact job title
  • tech_telephone - Technical contact telephone number including international country code. (eg 001 415 12345678)
  • tech_email - Technical Contact email address

  • approveremail - The approverEmail value (e.g. ssladmin@domainname.com).
    Valid approverEmail values are:
    • One of the registered domain contacts (admin or tech) found in the whois database for the associated domain.
    • Or one of the pre-setup emails listed belowsetup @domainname.com.For sub domains an email @domainname.com is also valid
    • admin
    • administrator
    • hostmaster
    • info
    • SSLadmin
    • SSLadministrator
    • SSLwebmaster
    • sysadmin
    • webmaster
    • root
    • is
    • it
    • mis
    • postmaster
    • support@geotrust.com (As a last resort this email should be used. This may take several business days when used.)

  • software - Web Server software identifier for which the certificate is purchased.
    Valid Web Server software identifiers are:
    • IIS
    • Other
  • csrString - Base64 encoded CSR string complete with the begin and end markers. eg
    -----BEGIN NEW CERTIFICATE REQUEST-----
    MIIBwzCCASwCAQAwgYIxCzAJBgNVBAYTAklOMRQwEgYDVQQIEwtNYWhhcmFzaHRyYTEPMA0GA1UE BxMGTXVtYmFpMRcwFQYDVQQKEw5NYWhlc2ggUHZ0IEx0ZDEYMBYGA1UECxMPUHJpdmF0ZSBDb21w YW55MRkwFwYDVQQDExB2ZXJpZW5yb2xsMDEuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKB gQCMSw8CmFebNAiyvwG7HJ/bGBqgqZvkNpzQtmtd79id+LcAXbCx5+TDdoTeGhQ33dUC2c2g5dxx N2hqRlR1H+vFR/FeYXC41abfPm5jS3OTQ4J1H/HM6lm4MVVEIQLwjzUxPtsUML5QtBjkolob2VB7 8A9QdDvSEkS+COaMXRSUqQIDAQABoAAwDQYJKoZIhvcNAQEEBQADgYEACCpjqsN2ZRjGtPTWp1G+ jHTrgAamxSDrHAddw9mi1IDk1N3ZXgp5gHBZ4L5av+4E6GUhTE5FCLylNxojxMjHnssALFjabqed ufJIj0ay8YSS6fBhXQeVE4oGP96djeheLLigCEAufzWjprr6oA6YRXmwAAdokmpkjyxwrtlNV0I=
    -----END NEW CERTIFICATE REQUEST-----
Returns:
Hashtable with following keys
  • invoiceid - ID for invoice generated
  • customercost - Cost for customer
  • customerid - customer's ID to which renewed order belongs
  • domainname - domain for which order is renewed
Certain other information related to the action is also returned as a part of the Hashtable
Throws:
LogicBoxesException
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD