diff options
author | Frederic Peters <fpeters@entrouvert.com> | 2006-02-21 09:53:29 +0000 |
---|---|---|
committer | Frederic Peters <fpeters@entrouvert.com> | 2006-02-21 09:53:29 +0000 |
commit | 4e6404fa28b3cde75e71af581be410606540e479 (patch) | |
tree | 9bbe12018ed53fcf52839d80e51e1ed66324d9ac /docs | |
parent | bdea328f3e99b1ca22d6533c83ac9c28cbfd41d9 (diff) | |
download | lasso-4e6404fa28b3cde75e71af581be410606540e479.tar.gz lasso-4e6404fa28b3cde75e71af581be410606540e479.tar.xz lasso-4e6404fa28b3cde75e71af581be410606540e479.zip |
added short descriptions to every lib: classes
Diffstat (limited to 'docs')
20 files changed, 857 insertions, 0 deletions
diff --git a/docs/reference/tmpl/lib_assertion.sgml b/docs/reference/tmpl/lib_assertion.sgml new file mode 100644 index 00000000..403299ec --- /dev/null +++ b/docs/reference/tmpl/lib_assertion.sgml @@ -0,0 +1,47 @@ +<!-- ##### SECTION Title ##### --> +LassoLibAssertion + +<!-- ##### SECTION Short_Description ##### --> +<lib:Assertion> + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoLibAssertion ##### --> +<para> + +</para> + +@InResponseTo: + +<!-- ##### FUNCTION lasso_lib_assertion_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION lasso_lib_assertion_new_full ##### --> +<para> + +</para> + +@issuer: +@requestID: +@audience: +@notBefore: +@notOnOrAfter: +@Returns: + + diff --git a/docs/reference/tmpl/lib_authentication_statement.sgml b/docs/reference/tmpl/lib_authentication_statement.sgml new file mode 100644 index 00000000..665bcdb0 --- /dev/null +++ b/docs/reference/tmpl/lib_authentication_statement.sgml @@ -0,0 +1,49 @@ +<!-- ##### SECTION Title ##### --> +LassoLibAuthenticationStatement + +<!-- ##### SECTION Short_Description ##### --> +<lib:AuthenticationStatement> + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoLibAuthenticationStatement ##### --> +<para> + +</para> + +@AuthnContext: +@ReauthenticateOnOrAfter: +@SessionIndex: + +<!-- ##### FUNCTION lasso_lib_authentication_statement_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION lasso_lib_authentication_statement_new_full ##### --> +<para> + +</para> + +@authenticationMethod: +@authenticationInstant: +@reauthenticateOnOrAfter: +@sp_identifier: +@idp_identifier: +@Returns: + + diff --git a/docs/reference/tmpl/lib_authn_context.sgml b/docs/reference/tmpl/lib_authn_context.sgml new file mode 100644 index 00000000..f474da76 --- /dev/null +++ b/docs/reference/tmpl/lib_authn_context.sgml @@ -0,0 +1,36 @@ +<!-- ##### SECTION Title ##### --> +LassoLibAuthnContext + +<!-- ##### SECTION Short_Description ##### --> +<lib:AuthnContext> + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoLibAuthnContext ##### --> +<para> + +</para> + +@AuthnContextClassRef: +@AuthnContextStatementRef: +@AuthenticationContextStatement: + +<!-- ##### FUNCTION lasso_lib_authn_context_new ##### --> +<para> + +</para> + +@Returns: + + diff --git a/docs/reference/tmpl/lib_authn_request_envelope.sgml b/docs/reference/tmpl/lib_authn_request_envelope.sgml new file mode 100644 index 00000000..f345bb5c --- /dev/null +++ b/docs/reference/tmpl/lib_authn_request_envelope.sgml @@ -0,0 +1,52 @@ +<!-- ##### SECTION Title ##### --> +LassoLibAuthnRequestEnvelope + +<!-- ##### SECTION Short_Description ##### --> +<lib:AuthnRequestEnvelope> + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoLibAuthnRequestEnvelope ##### --> +<para> + +</para> + +@parent: +@Extension: +@AuthnRequest: +@ProviderID: +@ProviderName: +@AssertionConsumerServiceURL: +@IDPList: +@IsPassive: + +<!-- ##### FUNCTION lasso_lib_authn_request_envelope_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION lasso_lib_authn_request_envelope_new_full ##### --> +<para> + +</para> + +@authnRequest: +@providerID: +@assertionConsumerServiceURL: +@Returns: + + diff --git a/docs/reference/tmpl/lib_authn_response.sgml b/docs/reference/tmpl/lib_authn_response.sgml new file mode 100644 index 00000000..25f0c186 --- /dev/null +++ b/docs/reference/tmpl/lib_authn_response.sgml @@ -0,0 +1,39 @@ +<!-- ##### SECTION Title ##### --> +LassoLibAuthnResponse + +<!-- ##### SECTION Short_Description ##### --> +<lib:AuthnResponse> + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoLibAuthnResponse ##### --> +<para> + +</para> + +@Extension: +@ProviderID: +@RelayState: +@consent: + +<!-- ##### FUNCTION lasso_lib_authn_response_new ##### --> +<para> + +</para> + +@providerID: +@request: +@Returns: + + diff --git a/docs/reference/tmpl/lib_authn_response_envelope.sgml b/docs/reference/tmpl/lib_authn_response_envelope.sgml new file mode 100644 index 00000000..6d899ea4 --- /dev/null +++ b/docs/reference/tmpl/lib_authn_response_envelope.sgml @@ -0,0 +1,39 @@ +<!-- ##### SECTION Title ##### --> +LassoLibAuthnResponseEnvelope + +<!-- ##### SECTION Short_Description ##### --> +<lib:AuthnResponseEnvelope> + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoLibAuthnResponseEnvelope ##### --> +<para> + +</para> + +@parent: +@Extension: +@AuthnResponse: +@AssertionConsumerServiceURL: + +<!-- ##### FUNCTION lasso_lib_authn_response_envelope_new ##### --> +<para> + +</para> + +@response: +@assertionConsumerServiceURL: +@Returns: + + diff --git a/docs/reference/tmpl/lib_federation_termination_notification.sgml b/docs/reference/tmpl/lib_federation_termination_notification.sgml new file mode 100644 index 00000000..962b5f6c --- /dev/null +++ b/docs/reference/tmpl/lib_federation_termination_notification.sgml @@ -0,0 +1,50 @@ +<!-- ##### SECTION Title ##### --> +LassoLibFederationTerminationNotification + +<!-- ##### SECTION Short_Description ##### --> +<lib:FederationTerminationNotification> + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoLibFederationTerminationNotification ##### --> +<para> + +</para> + +@Extension: +@ProviderID: +@NameIdentifier: +@consent: +@RelayState: + +<!-- ##### FUNCTION lasso_lib_federation_termination_notification_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION lasso_lib_federation_termination_notification_new_full ##### --> +<para> + +</para> + +@providerID: +@nameIdentifier: +@sign_type: +@sign_method: +@Returns: + + diff --git a/docs/reference/tmpl/lib_idp_entries.sgml b/docs/reference/tmpl/lib_idp_entries.sgml new file mode 100644 index 00000000..934d401b --- /dev/null +++ b/docs/reference/tmpl/lib_idp_entries.sgml @@ -0,0 +1,34 @@ +<!-- ##### SECTION Title ##### --> +LassoLibIDPEntries + +<!-- ##### SECTION Short_Description ##### --> +<lib:IDPEntries> + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoLibIDPEntries ##### --> +<para> + +</para> + +@IDPEntry: + +<!-- ##### FUNCTION lasso_lib_idp_entries_new ##### --> +<para> + +</para> + +@Returns: + + diff --git a/docs/reference/tmpl/lib_idp_entry.sgml b/docs/reference/tmpl/lib_idp_entry.sgml new file mode 100644 index 00000000..15f3a5cd --- /dev/null +++ b/docs/reference/tmpl/lib_idp_entry.sgml @@ -0,0 +1,36 @@ +<!-- ##### SECTION Title ##### --> +LassoLibIDPEntry + +<!-- ##### SECTION Short_Description ##### --> +<lib:IDPEntry> + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoLibIDPEntry ##### --> +<para> + +</para> + +@ProviderID: +@ProviderName: +@Loc: + +<!-- ##### FUNCTION lasso_lib_idp_entry_new ##### --> +<para> + +</para> + +@Returns: + + diff --git a/docs/reference/tmpl/lib_idp_list.sgml b/docs/reference/tmpl/lib_idp_list.sgml new file mode 100644 index 00000000..82f41e2c --- /dev/null +++ b/docs/reference/tmpl/lib_idp_list.sgml @@ -0,0 +1,35 @@ +<!-- ##### SECTION Title ##### --> +LassoLibIDPList + +<!-- ##### SECTION Short_Description ##### --> +<lib:IDPList> + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoLibIDPList ##### --> +<para> + +</para> + +@IDPEntries: +@GetComplete: + +<!-- ##### FUNCTION lasso_lib_idp_list_new ##### --> +<para> + +</para> + +@Returns: + + diff --git a/docs/reference/tmpl/lib_logout_request.sgml b/docs/reference/tmpl/lib_logout_request.sgml new file mode 100644 index 00000000..0a1e5bd0 --- /dev/null +++ b/docs/reference/tmpl/lib_logout_request.sgml @@ -0,0 +1,52 @@ +<!-- ##### SECTION Title ##### --> +LassoLibLogoutRequest + +<!-- ##### SECTION Short_Description ##### --> +<lib:LogoutRequest> + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoLibLogoutRequest ##### --> +<para> + +</para> + +@Extension: +@ProviderID: +@NameIdentifier: +@SessionIndex: +@RelayState: +@consent: +@NotOnOrAfter: + +<!-- ##### FUNCTION lasso_lib_logout_request_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION lasso_lib_logout_request_new_full ##### --> +<para> + +</para> + +@providerID: +@nameIdentifier: +@sign_type: +@sign_method: +@Returns: + + diff --git a/docs/reference/tmpl/lib_logout_response.sgml b/docs/reference/tmpl/lib_logout_response.sgml new file mode 100644 index 00000000..a40dbb31 --- /dev/null +++ b/docs/reference/tmpl/lib_logout_response.sgml @@ -0,0 +1,46 @@ +<!-- ##### SECTION Title ##### --> +LassoLibLogoutResponse + +<!-- ##### SECTION Short_Description ##### --> +<lib:LogoutResponse> + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoLibLogoutResponse ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION lasso_lib_logout_response_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION lasso_lib_logout_response_new_full ##### --> +<para> + +</para> + +@providerID: +@statusCodeValue: +@request: +@sign_type: +@sign_method: +@Returns: + + diff --git a/docs/reference/tmpl/lib_name_identifier_mapping_request.sgml b/docs/reference/tmpl/lib_name_identifier_mapping_request.sgml new file mode 100644 index 00000000..82925297 --- /dev/null +++ b/docs/reference/tmpl/lib_name_identifier_mapping_request.sgml @@ -0,0 +1,51 @@ +<!-- ##### SECTION Title ##### --> +LassoLibNameIdentifierMappingRequest + +<!-- ##### SECTION Short_Description ##### --> +<lib:NameIdentifierMappingRequest> + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoLibNameIdentifierMappingRequest ##### --> +<para> + +</para> + +@Extension: +@ProviderID: +@NameIdentifier: +@TargetNamespace: +@consent: + +<!-- ##### FUNCTION lasso_lib_name_identifier_mapping_request_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION lasso_lib_name_identifier_mapping_request_new_full ##### --> +<para> + +</para> + +@providerID: +@nameIdentifier: +@targetNamespace: +@sign_type: +@sign_method: +@Returns: + + diff --git a/docs/reference/tmpl/lib_name_identifier_mapping_response.sgml b/docs/reference/tmpl/lib_name_identifier_mapping_response.sgml new file mode 100644 index 00000000..26440da5 --- /dev/null +++ b/docs/reference/tmpl/lib_name_identifier_mapping_response.sgml @@ -0,0 +1,50 @@ +<!-- ##### SECTION Title ##### --> +LassoLibNameIdentifierMappingResponse + +<!-- ##### SECTION Short_Description ##### --> +<lib:NameIdentifierMappingResponse> + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoLibNameIdentifierMappingResponse ##### --> +<para> + +</para> + +@Extension: +@ProviderID: +@Status: +@NameIdentifier: + +<!-- ##### FUNCTION lasso_lib_name_identifier_mapping_response_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION lasso_lib_name_identifier_mapping_response_new_full ##### --> +<para> + +</para> + +@provideRID: +@statusCodeValue: +@request: +@sign_type: +@sign_method: +@Returns: + + diff --git a/docs/reference/tmpl/lib_register_name_identifier_request.sgml b/docs/reference/tmpl/lib_register_name_identifier_request.sgml new file mode 100644 index 00000000..a7e199da --- /dev/null +++ b/docs/reference/tmpl/lib_register_name_identifier_request.sgml @@ -0,0 +1,53 @@ +<!-- ##### SECTION Title ##### --> +LassoLibRegisterNameIdentifierRequest + +<!-- ##### SECTION Short_Description ##### --> +<lib:RegisterNameIdentifierRequest> + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoLibRegisterNameIdentifierRequest ##### --> +<para> + +</para> + +@Extension: +@ProviderID: +@IDPProvidedNameIdentifier: +@SPProvidedNameIdentifier: +@OldProvidedNameIdentifier: +@RelayState: + +<!-- ##### FUNCTION lasso_lib_register_name_identifier_request_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION lasso_lib_register_name_identifier_request_new_full ##### --> +<para> + +</para> + +@providerID: +@idpNameIdentifier: +@spNameIdentifier: +@oldNameIdentifier: +@sign_type: +@sign_method: +@Returns: + + diff --git a/docs/reference/tmpl/lib_register_name_identifier_response.sgml b/docs/reference/tmpl/lib_register_name_identifier_response.sgml new file mode 100644 index 00000000..17df145c --- /dev/null +++ b/docs/reference/tmpl/lib_register_name_identifier_response.sgml @@ -0,0 +1,46 @@ +<!-- ##### SECTION Title ##### --> +LassoLibRegisterNameIdentifierResponse + +<!-- ##### SECTION Short_Description ##### --> +<lib:RegisterNameIdentifierResponse> + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoLibRegisterNameIdentifierResponse ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION lasso_lib_register_name_identifier_response_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION lasso_lib_register_name_identifier_response_new_full ##### --> +<para> + +</para> + +@providerID: +@statusCodeValue: +@request: +@sign_type: +@sign_method: +@Returns: + + diff --git a/docs/reference/tmpl/lib_request_authn_context.sgml b/docs/reference/tmpl/lib_request_authn_context.sgml new file mode 100644 index 00000000..f2d8e0d1 --- /dev/null +++ b/docs/reference/tmpl/lib_request_authn_context.sgml @@ -0,0 +1,36 @@ +<!-- ##### SECTION Title ##### --> +LassoLibRequestAuthnContext + +<!-- ##### SECTION Short_Description ##### --> +<lib:RequestAuthnContext> + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoLibRequestAuthnContext ##### --> +<para> + +</para> + +@AuthnContextClassRef: +@AuthnContextStatementRef: +@AuthnContextComparison: + +<!-- ##### FUNCTION lasso_lib_request_authn_context_new ##### --> +<para> + +</para> + +@Returns: + + diff --git a/docs/reference/tmpl/lib_scoping.sgml b/docs/reference/tmpl/lib_scoping.sgml new file mode 100644 index 00000000..01c8a72d --- /dev/null +++ b/docs/reference/tmpl/lib_scoping.sgml @@ -0,0 +1,35 @@ +<!-- ##### SECTION Title ##### --> +LassoLibScoping + +<!-- ##### SECTION Short_Description ##### --> +<lib:Scoping> + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoLibScoping ##### --> +<para> + +</para> + +@ProxyCount: +@IDPList: + +<!-- ##### FUNCTION lasso_lib_scoping_new ##### --> +<para> + +</para> + +@Returns: + + diff --git a/docs/reference/tmpl/lib_status_response.sgml b/docs/reference/tmpl/lib_status_response.sgml new file mode 100644 index 00000000..9e0a76f4 --- /dev/null +++ b/docs/reference/tmpl/lib_status_response.sgml @@ -0,0 +1,37 @@ +<!-- ##### SECTION Title ##### --> +LassoLibStatusResponse + +<!-- ##### SECTION Short_Description ##### --> +<lib:StatusResponse> + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoLibStatusResponse ##### --> +<para> + +</para> + +@Extension: +@ProviderID: +@Status: +@RelayState: + +<!-- ##### FUNCTION lasso_lib_status_response_new ##### --> +<para> + +</para> + +@Returns: + + diff --git a/docs/reference/tmpl/lib_subject.sgml b/docs/reference/tmpl/lib_subject.sgml new file mode 100644 index 00000000..e913eafc --- /dev/null +++ b/docs/reference/tmpl/lib_subject.sgml @@ -0,0 +1,34 @@ +<!-- ##### SECTION Title ##### --> +LassoLibSubject + +<!-- ##### SECTION Short_Description ##### --> +<lib:Subject> + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT LassoLibSubject ##### --> +<para> + +</para> + +@IDPProvidedNameIdentifier: + +<!-- ##### FUNCTION lasso_lib_subject_new ##### --> +<para> + +</para> + +@Returns: + + |