IDL Documentation for "TransportSecurity.CredentialsAcquirer"

Local Interface TransportSecurity::CredentialsAcquirer

local interface CredentialsAcquirer

An object of this interface is created by the CredentialsCurator in managing the acquisition of an OwnCredentials object. The acquisition process, determined by the acquisition method, may be a multistep process.

Attribute Index

acquisition_method: The acquisition_method attribute contains the acquisition method identifier naming the method by which these credentials are being acquired.
current_status: The current_status attribute contains the current acquisition status of the acquisition process.
mechanism_id: The mechanism for which these credentials are being acquired, such as "TLS".
nth_iteration: If the acquisition process is a multistep process through calls to this acquirer, then this attribute contains the current iteration.

Operation Index

continue_acquisition: This operation continues the acquisition.
destroy: This operation is used to destroy the object before get_credentials is called.
get_continuation_data: If the current_status attribute contains the AQST_Continued value, this operation returns, if necessary and supported by the acquisition method, any data that may direct the acquisition.
get_credentials: Once the current_status attribute has the AQST_Succeeded value, a call to this operation is used to retrieve the acquired OwnCredentials and, optionally, place the credentials on the curator's default own credentials list (for use with default ContextEstablishmentPolicy and ObjectCredentialsPolicy).

Attributes

acquisition_method

readonly attribute AcquisitionMethod acquisition_method;

The acquisition_method attribute contains the acquisition method identifier naming the method by which these credentials are being acquired.

current_status

readonly attribute AcquisitionStatus current_status;

The current_status attribute contains the current acquisition status of the acquisition process.

mechanism_id

readonly attribute MechanismId mechanism_id;

The mechanism for which these credentials are being acquired, such as "TLS".

nth_iteration

readonly attribute unsigned long nth_iteration;

If the acquisition process is a multistep process through calls to this acquirer, then this attribute contains the current iteration.

Operations

continue_acquisition

AcquisitionStatus continue_acquisition(in any acquisition_arguments);

This operation continues the acquisition. The argument data is dependent on the acquisition method.

destroy

void destroy();

This operation is used to destroy the object before get_credentials is called. Any operation called on a destroyed CredentialsAcquirer raises a BAD_INV_ORDER exception.

get_continuation_data

any get_continuation_data();

If the current_status attribute contains the AQST_Continued value, this operation returns, if necessary and supported by the acquisition method, any data that may direct the acquisition.

get_credentials

OwnCredentials get_credentials(in boolean on_list);

Once the current_status attribute has the AQST_Succeeded value, a call to this operation is used to retrieve the acquired OwnCredentials and, optionally, place the credentials on the curator's default own credentials list (for use with default ContextEstablishmentPolicy and ObjectCredentialsPolicy).

The CredentialsAcquirer object is destroyed after this call. Any operation called on a destroyed CredentialsAcquirer raises a BAD_INV_ORDER exception.

If this operation in invoked when the current_status attribute does not have the AQST_Succeeded value, a BAD_INV_ORDER exception will be raised.

Parameters:: on_list - TRUE if these credentials go on the default own credentials list of the CredentialsCurator.

Generated by the ORBacus IDL-to-HTML translator