service-id

This stanza entry defines the authorization API service for functions that enable a plug-in to obtain the contents of a defined portion of the protected object hierarchy. Service functions can also enable a plug-in to define application-specific administration tasks that also return commands that do those tasks.

service-id = {short_name|path_to_dll} [-pobj protected_object_hierarchy_name ] [& params]

Define the authorization API service for functions that enable a plug-in to obtain the contents of a defined portion of the protected object hierarchy. Service functions can also enable a plug-in to define application-specific administration tasks that also return commands that do those tasks.

Each stanza entry defines different types of aznAPI service.

Options

Each entry has the following format.

service-id

Developer-specified ID of the administration service. An authorization API application can register more than one administration service plug-in, but each must have a unique service ID.

short_name|path_to_dll

The path to the dynamic link library (DLL) containing the executable code for the service. If the DLL is in a directory that is normally searched by the system (for example, /usr/lib on AIX, Linux, and Solaris operating systems or the value of the PATH environment variable on Windows operating systems), do not specify the full path to the DLL, specify only the DLL name. If we want a platform-independent DLL name, so it can be loaded on any supported platform, provide a short name. The short name is added as a prefix and appended with known library prefixes and suffixes for each platform, and each possibility is searched in turn. For example, with a short name of azn_ent_user, the following names are automatically searched for on each platform:

AIX®

libazn_ent_user.so
libazn_ent_user.a

Linux®

libazn_ent_user.so

Solaris

libazn_ent_user.so

Windows

azn_ent_user.dll

protected_object_hierarchy_name

Optional: The name of the protected object hierarchy. This option refers either to the name of a protected object space (hierarchy) or to a protected object. Protected object hierarchy names must be unique for each administration service plug-in within the scope of an authorization API application. To support failover, multiple authorization API application instances can be registered to service the same protected object hierarchy names. Failover support allows for the administration of an object space if a particular authorization API application server fails.

params

Optional: The additional initialization arguments that can be passed to the external authorization service. The arguments must be preceded by the ampersand (&); for example, & -server fred. The authorization service does not process the characters after the ampersand. It passes these characters directly to the administration service plug-in. The service definition is described in more detail in the Authorization C API Developer Reference.

Usage

Optional

Default value

There is no default value.

Example

AZN_ADMIN_SVC_TRACE = pdtraceadmin

Parent topic: [aznapi-admin-services] stanza