ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/ictxapplicationinfo.htm

279 lines
10 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<TITLE>ictxApplicationInfo - Authentication Context Application Info</TITLE>
<!-- Begin Header Records ========================================= -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- Edited by Kersten Jan 02 -->
<!-- Created by Therese Dalton on 17 July 2001 -->
<!--File edited for Tidy July 2001 -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</HEAD>
<BODY>
<a name="Top_Of_Page"></a>
<!--Java sync-link-->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<!-- ============================================================== -->
<!-- -->
<!-- -->
<!-- ============================================================== -->
<H2>ictxApplicationInfo - Authentication Context Application Info</H2>
<!-- ============================================================== -->
<!-- -->
<!-- D E S C R I P T I O N -->
<!-- -->
<!-- ============================================================== -->
<P>This describes the application information that may
be provided when working with authentication contexts.
See <a href="#eserver_notes">eServer Implementation
Notes</a> for details on platform-specific details.
</P>
<!-- ============================================================== -->
<!-- -->
<!-- S T R U C T U R E -->
<!-- -->
<!-- ============================================================== -->
<H3>
<A name=Header_41>Application Information</A>
</H3>
<P>The structure ictxApplicationInfo_t describes the
application used for authentication
contexts.
New fields may be added to the end of this structure.
On a parse operation the fields will be returned if they exist
in the authentication context. Code that has been rebuilt with
the new structure may access these new fields.
A version supplied with the build information indicates which new
fields have been provided.
</P>
<!-- ============================================================== -->
<!-- ictxApplicationInfo_t structure -->
<!-- ============================================================== -->
<P>
The layout for ictxApplicationInfo_t follows:</P>
<PRE>
typedef struct ictxApplicationInfo
{
char * appid; /* Application identifier name */
char * instance; /* Application instance info */
char * implemSpecific; /* Additional data, optional */
} ictxApplicationInfo_t;
</PRE>
<!-- ============================================================== -->
<!-- -->
<!-- F I E L D D E S C R I P T I O N S -->
<!-- -->
<!-- ============================================================== -->
<H4>
<A name=Header_41>Field Descriptions</A>
</H4>
<DL>
<!-- ============================================================== -->
<!-- appid -->
<!-- ============================================================== -->
<DT>
<STRONG>appid</STRONG>&nbsp;&nbsp;
<DD>The name of the application identifier that has been defined
for the application. <BR><BR>
</DD>
<!-- ============================================================== -->
<!-- instance -->
<!-- ============================================================== -->
<DT>
<STRONG>instance</STRONG>&nbsp;&nbsp;
<DD>The instance identifier that uniquely identifies the instance
of the application in the network. <BR> <BR>
</DD>
<!-- ============================================================== -->
<!-- implemSpecific -->
<!-- ============================================================== -->
<DT>
<STRONG>implemSpecific</STRONG>&nbsp;&nbsp;
<DD>This is implementation specific data that would be added to
an authentication context. This value may be NULL.
The sender and the receiver must agree on format and content of this data.
The recommended layout for this data would be a series of the following:
<PRE>
&lt;LABEL&gt;xxxxx&lt;/LABEL&gt;&lt;DATA&gt;yyyyy&lt;/DATA&gt;
</PRE>
An example would be:
<PRE>
&lt;LABEL&gt;TCPIP address&lt;/LABEL&gt;&lt;DATA&gt;9.5.6.132&lt;/DATA&gt;
</PRE>
<BR>
</DD>
</DL>
<!-- ============================================================== -->
<!-- -->
<!-- B U I L D I N F O R M A T I O N -->
<!-- -->
<!-- ============================================================== -->
<H3>
<A name=Header_41>Build Information</A>
</H3>
<P>
The application information used for building of an
authentication context is contained in the ictxAppInfo
structure.
<!-- ============================================================== -->
<!-- ictxAppInfo structure -->
<!-- ============================================================== -->
The layout for ictxAppInfo follows:</P>
<PRE>
typedef struct ictxAppInfo
{
enum ictxAppInfoFormat format;
union
{
ictxAppInfoFormat0_t * format0;
} appInfo;
} ictxAppInfo_t;
</PRE>
<P>
<BR>
<!-- ============================================================== -->
<!-- -->
<!-- F I E L D D E S C R I P T I O N S -->
<!-- -->
<!-- ============================================================== -->
<H4>
<A name=Header_41>Field Descriptions</A>
</H4>
<DL>
<!-- ============================================================== -->
<!-- format -->
<!-- ============================================================== -->
<DT>
<STRONG>format</STRONG>&nbsp;&nbsp;
<DD>Valid values for the format are:
<PRE>
enum ictxAppInfoFormat {
ICTX_APP_INFO_FORMAT_0
};
</PRE>
<P>When format is ICTX_APP_INFO_FORMAT_0 (0), the <em>appInfo</em> field
must contain an ictxAppInfoFormat0_t structure.<BR>
<PRE>
typedef struct ictxAppInfoFormat0
{
{
int version;
ictxApplicationInfo_t * appInfo;
} ictxAppInfoFormat0_t;
</PRE>
<!-- ============================================================== -->
<!-- version -->
<!-- ============================================================== -->
<DT>
<STRONG>version</STRONG>&nbsp;&nbsp;
<DD>The version indicates which fields are available in the
the <em>appInfo</em> field. Version 0 corresponds to the initial structure
defined here. In the future if new fields are added to the appInfo
structure and the users wants to pass that information in for
a build they can indicate the new version of the structure that
they are providing.
<BR>
<BR>
</DD>
<!-- ============================================================== -->
<!-- appInfo -->
<!-- ============================================================== -->
<DT>
<STRONG>appInfo</STRONG>&nbsp;&nbsp;
<DD>This is the structure that contains the application
information fields.
<BR>
</DD>
</DL>
<BR>
<!-- ============================================================== -->
<!-- -->
<!-- E S E R V E R N O T E S -->
<!-- -->
<!-- ============================================================== -->
<h3>
<a name="eserver_notes">eServer Implementation Notes</a>
</h3>
<ol>
<li>
<strong>AIX implementation details:</strong>
<ul>
<li>
None.
</li>
</ul>
</li>
<li>
<strong>Linux implementation details:</strong>
<ul>
<li>
None.
</li>
</ul>
</li>
<li>
<strong>i5/OS implementation details:</strong><br>
<ul>
<li>
None.
</li>
</ul>
</li>
<li>
<strong>Windows implementation details:</strong>
<ul>
<li>
None.
</li>
</ul>
</li>
<li>
<strong>z/OS implementation notes:</strong><br>
<ul>
<li>
None.
</li>
</ul>
</li>
</ol>
<!-- ============================================================== -->
<!-- The End -->
<!-- ============================================================== -->
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center">
<a href="#Top_Of_Page">Top</a> |
<a href="sec.htm">Security APIs</a> |
<a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</BODY>
</HTML>