openstack/barbican
Code Issues Proposed changes

Merge "Updating symantec plugin docstrings"

Browse Source
This commit is contained in:
Jenkins 2014-08-17 22:33:08 +00:00 committed by Gerrit Code Review
commit f8f90b123b
1 changed files with 33 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
barbican/plugin/symantec.py
View File

@ -143,16 +143,19 @@ def _ca_create_order(self, order_meta, plugin_meta):
All required order parameters must be stored as a dict in All required order parameters must be stored as a dict in
order_meta. order_meta.
Required fields are: Required fields are:
partnerCode, productCode, partnerOrderId, organizationName, PartnerCode, ProductCode, PartnerOrderId, OrganizationName,
addressLine1, city, region, postalCode, country, organizationPhone AddressLine1, City, Region, PostalCode, Country, OrganizationPhone
validityPeriod, serverCount, webServerType, adminContactFirstName, ValidityPeriod, ServerCount, WebServerType, AdminContactFirstName,
adminContactLastName, adminContactPhone, adminContactEmail, AdminContactLastName, AdminContactPhone, AdminContactEmail,
adminContactTitle, adminContactAddressLine1, adminContactCity, AdminContactTitle, AdminContactAddressLine1, AdminContactCity,
adminContactRegion, adminContactPostalCode, adminContactCountry, bill AdminContactRegion, AdminContactPostalCode, AdminContactCountry,
and tech contact info, and csr. BillingContact*, TechContact*, and CSR.
Optional Parameters: techSameAsAdmin, billSameAsAdmin, more options can be *The Billing and Tech contact information follows the same convention
found in Symantec's API docs. as the AdminContact fields.
Optional Parameters: TechSameAsAdmin, BillSameAsAdmin, more options can be
found in Symantec's API docs. Contact Symantec for the API document.
:returns: tuple with success, error message, and can retry :returns: tuple with success, error message, and can retry
""" """
@ -180,7 +183,7 @@ def _ca_get_order_status(self, plugin_meta):
"""Sends a request to the Symantec CA for details on an order. """Sends a request to the Symantec CA for details on an order.
Parameters needed for GetOrderByPartnerOrderID: Parameters needed for GetOrderByPartnerOrderID:
plugin_meta parameters: partnerOrderId, partnerCode plugin_meta parameters: PartnerOrderId, PartnerCode
If the order is complete, the Certificate is returned as a string. If the order is complete, the Certificate is returned as a string.
returns: tuple with success, error message, can retry, returns: tuple with success, error message, can retry,
@ -189,11 +192,11 @@ def _ca_get_order_status(self, plugin_meta):
api = Symantec(self.username, self.password, self.url) api = Symantec(self.username, self.password, self.url)
order_details = { order_details = {
"partnerOrderId": plugin_meta["PartnerOrderID"], "PartnerOrderID": plugin_meta["PartnerOrderID"],
"partnerCode": plugin_meta["PartnerCode"], "PartnerCode": plugin_meta["PartnerCode"],
"returnCertificateInfo": "TRUE", "ReturnCertificateInfo": "TRUE",
"returnFulfillment": "TRUE", "ReturnFulfillment": "TRUE",
"returnCaCerts": "TRUE", "ReturnCaCerts": "TRUE",
} }
try: try:
@ -210,10 +213,11 @@ def _ca_get_order_status(self, plugin_meta):
def _ca_modify_order(self, order_meta, plugin_meta): def _ca_modify_order(self, order_meta, plugin_meta):
"""Sends a request to the Symantec CA to modify an order. """Sends a request to the Symantec CA to modify an order.
Parameters needed for modifyOrder: Parameters needed for modifyOrder:
partnerorderid - Needed to specify order PartnerOrderID - Needed to specify order
partnercode - Needed to specify order PartnerCode - Needed to specify order
productcode - Needed to specify order ProductCode - Needed to specify order
Also need a dict, order_meta with the parameters/values to modify. Also need a dict, order_meta with the parameters/values to modify.
@ -222,9 +226,9 @@ def _ca_modify_order(self, order_meta, plugin_meta):
api = Symantec(self.username, self.password, self.url) api = Symantec(self.username, self.password, self.url)
order_details = { order_details = {
"partnerOrderId": plugin_meta["PartnerOrderID"], "PartnerOrderID": plugin_meta["PartnerOrderID"],
"partnerCode": plugin_meta["PartnerCode"], "PartnerCode": plugin_meta["PartnerCode"],
"productCode": plugin_meta["ProductCode"], "ProductCode": plugin_meta["ProductCode"],
} }
order_details.update(order_meta) order_details.update(order_meta)
@ -240,20 +244,21 @@ def _ca_modify_order(self, order_meta, plugin_meta):
def _ca_cancel_order(self, plugin_meta): def _ca_cancel_order(self, plugin_meta):
"""Sends a request to the Symantec CA to cancel an order. """Sends a request to the Symantec CA to cancel an order.
Parameters needed for modifyOrder: Parameters needed for modifyOrder:
partnerorderid - Needed to specify order PartnerOrderID - Needed to specify order
partnercode - Needed to specify order PartnerCode - Needed to specify order
productcode - Needed to specify order ProductCode - Needed to specify order
returns: tuple with success, error message, and can retry. returns: tuple with success, error message, and can retry.
""" """
api = Symantec(self.username, self.password, self.url) api = Symantec(self.username, self.password, self.url)
order_details = { order_details = {
"partnerOrderId": plugin_meta["PartnerOrderID"], "PartnerOrderID": plugin_meta["PartnerOrderID"],
"partnerCode": plugin_meta["PartnerCode"], "PartnerCode": plugin_meta["PartnerCode"],
"productCode": plugin_meta["ProductCode"], "ProductCode": plugin_meta["ProductCode"],
"modifyOrderOperation": "CANCEL", "ModifyOrderOperation": "CANCEL",
} }
try: try: