Difference between revisions of "Freeside:3:Documentation:Developer/FS/svc cert"

Latest revision as of 21:06, 27 June 2012

NAME

FS::svc_cert - Object methods for svc_cert records

SYNOPSIS

 use FS::svc_cert;

 $record = new FS::svc_cert \%hash;
 $record = new FS::svc_cert { 'column' => 'value' };

 $error = $record->insert;

 $error = $new_record->replace($old_record);

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::svc_cert object represents a certificate. FS::svc_cert inherits from FS::Record. The following fields are currently supported:

svcnum

primary key

recnum

recnum

privatekey

privatekey

csr

csr

certificate

certificate

cacert

cacert

common_name

common_name

organization

organization

organization_unit

organization_unit

city

city

state

state

country

country

cert_contact

contact email

METHODS

new HASHREF

Creates a new certificate. To add the certificate to the database, see "insert".

Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.

label

Returns a meaningful identifier for this example

insert

Adds this record to the database. If there is an error, returns the error, otherwise returns false.

delete

Delete this record from the database.

replace OLD_RECORD

Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.

check

Checks all fields to make sure this is a valid certificate. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

generate_privatekey [ KEYSIZE ]; check_privatekey

BUGS

SEE ALSO

FS::Record, schema.html from the base documentation.