Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 8244

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Interface XSecurityEnvironment</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../idl.css">
</head>
<body>
<div id="adc-idlref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XSecurityEnvironment-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="../../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Details</td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../../module-ix.html" class="namechain">::</a> <a href="../../../../module-ix.html" class="namechain">com</a> :: <a href="../../../module-ix.html" class="namechain">sun</a> :: <a href="../../module-ix.html" class="namechain">star</a> :: <a href="../module-ix.html" class="namechain">xml</a> :: <a href="module-ix.html" class="namechain">crypto</a> :: </p>
</td>
</tr>
<tr>
<td class="title"><table class="title-table" width="99%">
<tr>
<td width="25%" class="title2">unpublished </td>
<td width="50%" class="title">interface XSecurityEnvironment</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>not published</i></dd>
<dt><b>Description</b></dt>
<dd>* Interface of Security Environment
 </dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getPersonalCertificates">getPersonalCertificates</a></td>
<td class="imsum_right">* Get personal certificate from the environment
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getCertificate">getCertificate</a></td>
<td class="imsum_right">* Get certificate from the environment by issuer name and serial number
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#buildCertificatePath">buildCertificatePath</a></td>
<td class="imsum_right">* build certificate path from a certain certificate
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#createCertificateFromRaw">createCertificateFromRaw</a></td>
<td class="imsum_right">* Create certificate interface from raw DER encoded certificate
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#createCertificateFromAscii">createCertificateFromAscii</a></td>
<td class="imsum_right">* Create certificate interface from a BASE64 encoded certificate.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#verifyCertificate">verifyCertificate</a></td>
<td class="imsum_right">Verify a certificate.
 
 The method provides a way to verify a certificate.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getCertificateCharacters">getCertificateCharacters</a></td>
<td class="imsum_right">* Get a certificate characters.
 *
 * The method provides a way to get certificate characters like:
 * 1. Whether or not the certificate have a private key in the user profile.
 * 2. Whether or not the certificate is a trusted certificate.
 * 3. Whether or not the certificate is a self-signed certificate.
 * 
 * The certificate characters is defined as bit-wise long, please refer to
 * CertificateCharacters definition.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getSecurityEnvironmentInformation">getSecurityEnvironmentInformation</a></td>
<td class="imsum_right">* Get the Environment detail infos
 &nbsp;</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="getPersonalCertificates" class="membertitle">getPersonalCertificates</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">sequence&lt; ::com::sun::star::<a href="../../security/module-ix.html">security</a>::<a href="../../security/XCertificate.html">XCertificate</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>getPersonalCertificates</b>()</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../../uno/module-ix.html">uno</a>::<a href="../../uno/SecurityException.html">SecurityException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>* Get personal certificate from the environment
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getCertificate" class="membertitle">getCertificate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">::com::sun::star::<a href="../../security/module-ix.html">security</a>::<a href="../../security/XCertificate.html">XCertificate</a></td>
</tr>
<tr>
<td valign="top"><b>getCertificate</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;issuerName,</td>
</tr>
<tr>
<td/><td valign="top">[in] sequence&lt; byte &gt;</td>
<td valign="bottom">&nbsp;serialNumber )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../../uno/module-ix.html">uno</a>::<a href="../../uno/SecurityException.html">SecurityException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>* Get certificate from the environment by issuer name and serial number
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="buildCertificatePath" class="membertitle">buildCertificatePath</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">sequence&lt; ::com::sun::star::<a href="../../security/module-ix.html">security</a>::<a href="../../security/XCertificate.html">XCertificate</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>buildCertificatePath</b>(</td>
<td valign="top">[in] ::com::sun::star::<a href="../../security/module-ix.html">security</a>::<a href="../../security/XCertificate.html">XCertificate</a></td>
<td valign="bottom">&nbsp;beginCert )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../../uno/module-ix.html">uno</a>::<a href="../../uno/SecurityException.html">SecurityException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>* build certificate path from a certain certificate
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="createCertificateFromRaw" class="membertitle">createCertificateFromRaw</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">::com::sun::star::<a href="../../security/module-ix.html">security</a>::<a href="../../security/XCertificate.html">XCertificate</a></td>
</tr>
<tr>
<td valign="top"><b>createCertificateFromRaw</b>(</td>
<td valign="top">[in] sequence&lt; byte &gt;</td>
<td valign="bottom">&nbsp;rawCertificate )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../../uno/module-ix.html">uno</a>::<a href="../../uno/SecurityException.html">SecurityException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>* Create certificate interface from raw DER encoded certificate
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="createCertificateFromAscii" class="membertitle">createCertificateFromAscii</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">::com::sun::star::<a href="../../security/module-ix.html">security</a>::<a href="../../security/XCertificate.html">XCertificate</a></td>
</tr>
<tr>
<td valign="top"><b>createCertificateFromAscii</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;asciiCertificate )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../../uno/module-ix.html">uno</a>::<a href="../../uno/SecurityException.html">SecurityException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>* Create certificate interface from a BASE64 encoded certificate.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="verifyCertificate" class="membertitle">verifyCertificate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">long</td>
</tr>
<tr>
<td valign="top"><b>verifyCertificate</b>(</td>
<td valign="top">[in] ::com::sun::star::<a href="../../security/module-ix.html">security</a>::<a href="../../security/XCertificate.html">XCertificate</a></td>
<td valign="bottom">&nbsp;xEECertificate,</td>
</tr>
<tr>
<td/><td valign="top">[in] sequence&lt; ::com::sun::star::<a href="../../security/module-ix.html">security</a>::<a href="../../security/XCertificate.html">XCertificate</a> &gt;</td>
<td valign="bottom">&nbsp;intermediateCertificates )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../../uno/module-ix.html">uno</a>::<a href="../../uno/SecurityException.html">SecurityException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Verify a certificate.
 
 The method provides a way to verify a certificate.
 </dd>
<dt><b>Parameter xEECertificate</b></dt>
<dd>The certificate which is to be validated.

 </dd>
<dt><b>Parameter intermediateCertificates</b></dt>
<dd>Additional certificates which can be used by the method in constructing
 the certificate chain. The root certificate may also be contained. However,
 the implementation must check if the root certificate is indeed trusted by
 the user.
 All entries of the sequence must be non-null references.

 </dd>
<dt><b>Returns</b></dt>
<dd>The validation status will returned as a bit-wise long, please refer to
 CertificateValidity definition.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getCertificateCharacters" class="membertitle">getCertificateCharacters</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">long</td>
</tr>
<tr>
<td valign="top"><b>getCertificateCharacters</b>(</td>
<td valign="top">[in] ::com::sun::star::<a href="../../security/module-ix.html">security</a>::<a href="../../security/XCertificate.html">XCertificate</a></td>
<td valign="bottom">&nbsp;xCertificate )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../../uno/module-ix.html">uno</a>::<a href="../../uno/SecurityException.html">SecurityException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>* Get a certificate characters.
 *
 * The method provides a way to get certificate characters like:
 * 1. Whether or not the certificate have a private key in the user profile.
 * 2. Whether or not the certificate is a trusted certificate.
 * 3. Whether or not the certificate is a self-signed certificate.
 * 
 * The certificate characters is defined as bit-wise long, please refer to
 * CertificateCharacters definition.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getSecurityEnvironmentInformation" class="membertitle">getSecurityEnvironmentInformation</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">string</td>
</tr>
<tr>
<td valign="top"><b>getSecurityEnvironmentInformation</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>* Get the Environment detail infos
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>